Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Justfile #185

Merged
merged 10 commits into from
Mar 17, 2021
Merged

Justfile #185

merged 10 commits into from
Mar 17, 2021

Conversation

steven-terrana
Copy link

PR Details

Switch to using Just instead of Make

Description

  • removes the project's Makefile in favor of a Justfile
  • adds a CONTRIBUTING.adoc which outlines how to use the Justfile
  • adds a symlink of CONTRIBUTING.adoc so it can be rendered in the Antora docs

How Has This Been Tested

Lots of manual testing. We should continuously update this Justfile to streamline our processes wherever possible.

@steven-terrana steven-terrana added the documentation JTE Documentation Updates label Mar 14, 2021
@cokieffebah cokieffebah self-requested a review March 15, 2021 14:59
ci: test lint jpi

# Build the local Antora documentation
docs:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tried running this locally:
Unable to find image 'docker.pkg.github.com/boozallen/sdp-docs/builder:latest' locally
docker: Error response from daemon: Head https://docker.pkg.github.com/v2/boozallen/sdp-docs/builder/manifests/latest: no basic auth credentials.
I have ~/.git-credentials for github.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docker login docker.pkg.github.com and then use your GH user/pat

we could try to automate that part too

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm did not work

carlosokieffe@C02D80XNMD6V templating-engine-plugin % docker login docker.pkg.github.com                              
Username: cokieffebah
Password: 

Login Succeeded
carlosokieffe@C02D80XNMD6V templating-engine-plugin % 
carlosokieffe@C02D80XNMD6V templating-engine-plugin % git pull docker.pkg.github.com/boozallen/sdp-docs/builder:latest
fatal: 'docker.pkg.github.com/boozallen/sdp-docs/builder:latest' does not appear to be a git repository
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.
carlosokieffe@C02D80XNMD6V templating-engine-plugin % just docs                                                       
docker run -it --rm -v ~/.git-credentials:/home/antora/.git-credentials -v $(pwd):/app -w /app docker.pkg.github.com/boozallen/sdp-docs/builder generate --generator booz-allen-site-generator --to-dir docs/html docs/antora-playbook-local.yml
Unable to find image 'docker.pkg.github.com/boozallen/sdp-docs/builder:latest' locally
docker: Error response from daemon: unauthorized: Your request could not be authenticated by the GitHub Packages service. Please ensure your access token is valid and has the appropriate scopes configured.
See 'docker run --help'.
error: Recipe `docs` failed on line 47 with exit code 125

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approved the PR. just noting the issues with the docs.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you accidentally ran git pull instead of docker pull.

when you authenticated, did you use your password or a PAT?

if a PAT, it would need to have the read:packages scope

@steven-terrana steven-terrana merged commit 6e55e8d into jenkinsci:main Mar 17, 2021
@steven-terrana steven-terrana deleted the justfile branch April 27, 2021 22:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation JTE Documentation Updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants